Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix messaging for data processing changes #983

Merged

Conversation

ogibson
Copy link
Contributor

@ogibson ogibson commented Feb 16, 2024

Description

Details

URL to issue

N/A

Link to staging deployment URL (or set N/A)

N/A

Links to any PRs or resources related to this PR

Integration test branch

master

Merge checklist

Your changes will be ready for merging after all of the steps below have been completed.

Code updates

Have best practices and ongoing refactors being observed in this PR

  • Migrated any selector / reducer used to the new format.
  • All new dependency licenses have been checked for compatibility.

Manual/unit testing

  • Tested changes using InfraMock locally or no tests required for change, e.g. Kubernetes chart updates.
  • Validated that current unit tests for code work as expected and are sufficient for code coverage or no unit tests required for change, e.g. documentation update.
  • Unit tests written or no unit tests required for change, e.g. documentation update.

Integration testing

You must check the box below to run integration tests on the latest commit on your PR branch.
Integration tests have to pass before the PR can be merged. Without checking the box, your PR
will not pass the required status checks for merging.

  • Started end-to-end tests on the latest commit.

Documentation updates

  • Relevant Github READMEs updated or no GitHub README updates required.
  • Relevant Wiki pages created/updated or no Wiki updates required.

Optional

  • Staging environment is unstaged before merging.
  • Photo of a cute animal attached to this PR.

@ogibson ogibson added the safe to run Sensitive jobs are safe to be run label Feb 16, 2024
Copy link
Contributor

📦 Next.js Bundle Analysis for ui

This analysis was generated by the Next.js Bundle Analysis action. 🤖

One Page Changed Size

The following page changed size from the code in this PR compared to its base branch:

Page Size (compressed) First Load
/experiments/[experimentId]/data-processing 537.29 KB (🟡 +23 B) 1.08 MB
Details

Only the gzipped size is provided here based on an expert tip.

First Load is the size of the global bundle plus the bundle for the individual page. If a user were to show up to your website and land on a given page, the first load size represents the amount of javascript that user would need to download. If next/link is used, subsequent page loads would only need to download that page's bundle (the number in the "Size" column), since the global bundle has already been downloaded.

Any third party scripts you have added directly to your app using the <script> tag are not accounted for in this analysis

Next to the size is how much the size has increased or decreased compared with the base branch of this PR. If this percentage has increased by 20% or more, there will be a red status indicator applied, indicating that special attention should be given to this.

Copy link

codecov bot commented Feb 16, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (31e55a0) 85.21% compared to head (f527aff) 85.19%.

Additional details and impacted files
@@            Coverage Diff             @@
##           master     #983      +/-   ##
==========================================
- Coverage   85.21%   85.19%   -0.02%     
==========================================
  Files         548      548              
  Lines       10083    10085       +2     
  Branches     2175     2177       +2     
==========================================
  Hits         8592     8592              
- Misses       1431     1433       +2     
  Partials       60       60              

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@ogibson ogibson merged commit 7b3c92a into hms-dbmi-cellenics:master Feb 16, 2024
23 of 24 checks passed
@ogibson ogibson deleted the fix-clustering-warning branch February 16, 2024 19:24
!(changedQCFilters.size === 1 && changedQCFilters.has('embeddingSettings'))
&& (
<Alert
message='Note that you will lose your previous Louvain or Leiden clusters.'
Copy link
Contributor

@alexvpickering alexvpickering Feb 20, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@ogibson -- you will also lose custom cell sets, automatically annotated cell sets, etc

please have a bioinformatician review changes like this

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I did double check this specifically for custom cell sets and verified that we weren't losing them. Haven't checked for automatically annotated cell sets yet.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The issue came up when trying to merge this to our fork. Martin pointed out that we weren't actually losing all cell sets and he specifically asked for this change (also to fix the fact that running embedding doesn't remove annotations).

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Automatically annotated cellsets aren't lost either. Not when rerunning clustering nor when changing QC settings.

Copy link
Contributor

@alexvpickering alexvpickering Feb 20, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes but this warning is for any changes to QC -- I agree we could differentiate but it would get complicated:

  1. only embedding (UMAP vs TSNE) settings --> lose nothing
  2. only changing clustering settings --> lose louvain/leiden clustering only
  3. changing anything else in QC --> lose all annotations

I think until we implement this complicated logic for whether to show a warning, the cautionary principle is best (more likely to be upset if lose annotations and didn't know that would -- probably won't care if told that would lose annotations and didn't)

Copy link
Contributor Author

@ogibson ogibson Feb 20, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I tested changing other settings in QC, and you still don't lose annotations (only louvain clusters).

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I also thought we would lose them, but I believe this was changed at some point.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ahh nice! Could have swarn I checked that but happy to be wrong -- apologies for the misunderstanding :)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
safe to run Sensitive jobs are safe to be run
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants